home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 23 / CU Amiga - Super CD-ROM 23 (June 1998).iso / CreatingGames / Utilities / Amos / SupraProcs / SupraProcedures.Doc < prev    next >
Encoding:
Text File  |  1996-02-11  |  11.1 KB  |  284 lines
  1.       ****************************************************************
  2.       *                                                              *
  3.       *             Supra Procedures 1.0   January, 1996             *
  4.       *                                                              *
  5.       *                         Joseph Bolin                         *
  6.       *                       5468 Lark Avenue                       *
  7.       *                     Rockwell, Iowa 50469                     *
  8.       *              Intenet:jbolin@info.niacc.cc.ia.us              *
  9.       *                                                              *
  10.       *     Copyright 1996 by Joseph Bolin. All Rights Reserved.     *
  11.       *                                                              *
  12.       *                         DOCUMENTATION                        *
  13.       *                                                              *
  14.       ****************************************************************
  15.  
  16.  
  17.  
  18. ========
  19. Contents
  20. ========
  21.  
  22.  
  23. 1. Copyright and Distribution
  24. 2. Overview
  25. 3. Procedures
  26.    3a. ClipBob
  27.    3b. ColorBob
  28.    3c. CopyBob
  29.    3d. Curves
  30.    3e. InputText
  31.    3f. LargeText
  32.    3g. OutLineText
  33.    3h. Polygon
  34.    3i. ScreenSaver
  35.    3j. ScreenWipes
  36.    3k. Stencil
  37.    3l. Wash
  38.    3m. WashBob
  39.    3n. Zoom
  40.  
  41.  
  42. =============================
  43. 1. Copyright and Distribution
  44. =============================
  45.  
  46. Supra Procedures is Copyright 1996 by Joseph Bolin
  47.  
  48. Permission is granted to freely use and distribute Supra Procedures.
  49.  
  50. This distribution is shareware. If you use these procedures in your own
  51. programs, you should send me a payment of five or ten US dollars to me at
  52. the address below:
  53.  
  54.                                 Joseph Bolin
  55.                               5468 Lark Avenue
  56.                             Rockwell, Iowa 50469
  57.  
  58. You may contact me at this address to report bugs, comment on procedures
  59. you think this should include, or anything else. Or better, if you
  60. have access to e-mail, contact me at: jbolin@info.niacc.cc.ia.us
  61.  
  62. DISCLAIMER:  Supra Procedures is provided "as is", without warranty of any
  63.   kind.  In no event will the author be liable for any direct or indirect
  64.   damage or loss resulting from the use or misuse of these procedures.
  65.  
  66.  
  67. ===========================
  68. 2. Overview
  69. ===========================
  70.  
  71.  
  72. This is a collection of procedures for AMOS and AMOSPro. The following
  73. procedures should be included.
  74.  
  75. ------------*------------------------------------------*--------------*
  76. Procedure   |                    Use                   | AMOS/AMOSPRO |
  77. ------------*------------------------------------------*--------------*
  78. ClipBob     | Clip a section of a bob transparent      | AMOS/AMOSPRO |
  79. ColorBob    | Color a whole bob to a new color         | AMOS/AMOSPRO |
  80. CopyBob     | Copy one bob to another                  |   AMOSPRO    |
  81. Curves      | Several curve routines                   | AMOS/AMOSPRO |
  82. InputText   | A replacement for Input command          | AMOS/AMOSPRO |
  83. LargeText   | A large text printing routine            |   AMOSPRO    |
  84. OutLineText | Print outlined text                      | AMOS/AMOSPRO |
  85. Polygon     | Regular polygon drawing routine          | AMOS/AMOSPRO |
  86. ScreenSaver | Screen saver routine                     |   AMOSPRO    |
  87. ScreenWipes | Screen wipe routines                     | AMOS/AMOSPRO |
  88. Stencil     | Stencil a portion of the screen          |   AMOSPRO    |
  89. Wash        | Wash a portion of the screen             | AMOS/AMOSPRO |
  90. WashBob     | Wash one color of a bob to another color |   AMOSPRO    |
  91. Zoom        | Zoom by 2, 4 or 8                        | AMOS/AMOSPRO |
  92. ------------*---------------------------------------------------------*
  93.  
  94. ===========================
  95. 3. Procedures
  96. ===========================
  97.  
  98. In any procedure that uses a bob, pass a negative number to use an icon.
  99. e.g. to color icon 3 to color 14:  _COLORBOB[-3,14]
  100.  
  101. You only have to include the WASHML procedure once for each program.
  102.  
  103. ============================================================================
  104. 3a. ClipBob    Make a section of a bob transparent or opaque   AMOS/AMOSPRO
  105.  
  106. Use:     _CLIPBOB[_BOB,_XSTART,_YSTART,_XEND,_YEND,_MASK]
  107.  
  108. Inputs:  _BOB         Bob to make/erase mask on
  109.          _XPOS,_YPOS  Coordinates of upper-left of section to mask
  110.          _XEND,_YEND  Coordinates of lower-right of section to mask
  111.          _MASK        Flag:0=Make section transparent, 1=Make section opaque
  112.  
  113. Output:  Make a section of a bob either transparent or opaque
  114. ============================================================================
  115. 3b. ColorBob    Change a bob to one new color        AMOS/AMOSPRO
  116.  
  117. Use:     _COLORBOB[_BOB,_COLOR]
  118.  
  119. Inputs:  _BOB    Bob to change the color of
  120.          _COLOR  Color to change bob to
  121.  
  122. Output:  Change a bob to one color _COLOR.
  123.          You must have a mask to use this properly.
  124. ============================================================================
  125. 3c. CopyBob     Copy one bob to another              AMOS
  126.  
  127. Use:     _COPYBOB[_SRCBOB,_DESTBOB]
  128.  
  129. Inputs:  _SRCBOB   Source image
  130.          _DESTBOB  Destination image
  131.  
  132. Output:  Copys one bob to another, including mask.
  133.  
  134. Note:    You may copy from a bob to an icon or from an icon to a bob
  135. ============================================================================
  136. 3d. Curves      Three curve drawing routines       AMOS/AMOSPRO
  137.  
  138. Use:     _CURVE3[XB,YB,XC,YC,S]
  139.          _CURVE4[XB,YB,XC,YC,XT,YT,S]
  140.  
  141. Inputs:  XB,YB  Beginning coordinate of curve
  142.          XE,YE  Ending coordinate of curve
  143.          XC,YC  Control coordinate
  144.          XT,YT  Second control coordinate
  145.          S      Number of lines in curve
  146.  
  147. Output:  Draws a curve on the current screen in the current color
  148.  
  149. Use:     _CURVEMANY[N,S]
  150.  
  151. Inputs:  N          Number of points in the curve
  152.          S          Number of lines in the curve
  153.          XP(),YP()  Coordinates of points of the curve
  154.             XP(1),YP(1) are the starting coordinates
  155.             XP(N),YP(N) are the ending coordinates
  156.             The points between 1 and N are the control points
  157.  
  158. Output:  Draws a multiple point curve on the current screen
  159. ============================================================================
  160. 3e. InputText   A replacement for Input command       AMOS/AMOSPRO
  161.  
  162. Use:     _INPUT[_XPOS,_YPOS,_LENGTH,_SHOW,_DEFAULT$,_PEN,_PAPER,_CURSPEN]
  163.  
  164. Inputs:  _XPOS,_YPOS  Coordinates of input; Not limited to multiples of 8
  165.          _LENGTH      Maximum length of string
  166.          _SHOW        Length of shown section
  167.          _DEFAULT$    Default input
  168.          _PEN         Color of text
  169.          _PAPER       Background of text
  170.          _CURSPEN     Color of cursor
  171.  
  172. Output:  Param$       Inputed string
  173. ============================================================================
  174. 3f. LargeText   A large text printing routine         AMOSPRO
  175.  
  176. Use:     _LARGETEXT[_XPOS,_YPOS,_TEXT$,_PEN,_PAPER,_WIDTH,_HEIGHT]
  177.  
  178. Inputs:  _XPOS,_YPOS  Coordinates of text
  179.          _TEXT$       Text to print
  180.          _PEN         Color of text
  181.          _PAPER       Background color of text
  182.          _WIDTH       Integer multiple of normal text width
  183.          _HEIGHT      Integer multiple of normal text height
  184.  
  185. Output:  Prints expanded text on the current screen
  186. ============================================================================
  187. 3g. OutLineText  Print outlined text                  AMOS/AMOSPRO
  188.  
  189. Use:     _PRINTOUTLINE[_XPOS,_YPOS,_TEXT$,_COLOR,_OUTLINE]
  190.  
  191. Inputs:  _XPOS,_YPOS  Coordinates of text
  192.          _TEXT$       Text to print
  193.          _COLOR       Color of text
  194.          _OUTLINE     Color of outline of text
  195.  
  196. Output:  Prints outlined text on the current screen
  197. ============================================================================
  198. 3h. Polygon   Regular polygon drawing routine         AMOS/AMOSPRO
  199.  
  200. Use:     _POLYGON[_XPOS,_YPOS,_POINTS,_WIDTH,_HEIGHT,_ROTATE,_FILLED]
  201.  
  202. Inputs:  _XPOS,_YPOS  Center of polygon
  203.          _POINTS      Number of points in polygon
  204.          _WIDTH       Width of polygon
  205.          _HEIGHT      Height of polygon
  206.          _ROTATE      Rotation angle of polygon in degrees
  207.          _FILLED      Flag for fill:0=No, 1=Yes
  208.  
  209. Output:  Draws a regular polygon on the current screen
  210.          with the current ink colors and the current pattern
  211. ============================================================================
  212. 3i. ScreenSaver   Screen saver routine                AMOSPRO
  213.  
  214. Use:     _SCREENSAVER[_TIME,RESET]  Call this procedure in the main loop
  215.  
  216. Inputs:  _TIME  Number of jiffies before blanking
  217.          RESET  If non-zero, counter before blanking will be reset
  218.  
  219. Outputs: When screen is blanked _SCREENBLANK procedure is called
  220.          _SAVERLAST     =Last time since last mouse movement or key press
  221.          _SAVERLENGTH   =Length since last mouse movement or key press
  222.          _SAVERX,_SAVERY=Last mouse position
  223.          Param          =-1 if screen blank, 0 otherwise
  224.  
  225. Note:    This procedure does not check keypresses, so you should set the
  226.          parameter RESET when a key is pressed
  227. ============================================================================
  228. 3j. ScreenWipes   Screen Wipe procedures              AMOS/AMOSPRO
  229.  
  230. _WIPE1[_SOURCE,_DEST]  :  Wipes source screen into destination
  231. _WIPE2[_COLOR]         :  Clears current screen to _COLOR
  232. _WIPE3[_COLOR]         :  Clears current screen to _COLOR
  233. ============================================================================
  234. 3k. Stencil       Stencil a portion of the screen     AMOSPRO
  235.  
  236. Use:     _STENCIL[_SOURCE,_DESTBOB]
  237.  
  238. Inputs:  _SOURCE     Screen to stencil
  239.          _DESTBOB    Bob to make into stencil
  240.          _STENCIL()  Colors to stencil: 0=No, 1=Yes
  241.  
  242. Output:  Makes a bob from the source screen with the
  243.          unstenciled colors masked out
  244. ============================================================================
  245. 3l. Wash          Wash a portion of the screen        AMOS/AMOSPRO
  246.  
  247. Use:     _WASH[_STARTX,_STARTY,_ENDX,_ENDY]
  248.  
  249. Inputs:  _STARTX,_STARTY  Coordinates of up-left
  250.          _ENDX,_ENDY      Coordinates of down-right
  251.          _WASH()          Wash table:   _WASH(x)=Color to change x to
  252.  
  253. Output:  Washs an area of the screen
  254. ============================================================================
  255. 3m. WashBob       Wash one color of a bob to another color   AMOSPRO
  256.  
  257. Use:     _WASHBOB[_BOB,_COLOR,_CHANGE]
  258.  
  259. Inputs:  _BOB     Bob to change to color of
  260.          _COLOR   Color to change
  261.          _CHANGE  Color to change it to
  262.  
  263. Output:  Washes one color of a bob to another color
  264. ============================================================================
  265. 3n. Zoom          Zoom by 2, 4, or 8
  266.  
  267. Use:     _ZOOM[_POWER,_SOURCE,_XSTART,_YSTART,_XEND,_YEND,_XDEST,_YDEST]
  268.  
  269. Inputs:  _POWER   Zoom factor: 2, 4, or 8
  270.          _SOURCE  Screen to zoom from
  271.          _XSTART  Zoom start x pos        (multiple of 16)
  272.          _YSTART  Zoom start y pos
  273.          _XEND    Zoom end x pos (+1)
  274.          _YEND    Zoom end y pos (+1)
  275.          _DEST    Screen to zoom to
  276.          _XDEST   Zoom destination x pos (multiple of 16)
  277.          _YDEST   Zoom destination y pos
  278.  
  279. Output:  Zooms the source area to the destination area and expands it
  280.  
  281. Note:    For Zoom factors of 2 or 4, the X size must be a multiple of 16
  282.          For a Zoom factor of 8, the X size must be a multiple of 8
  283. ============================================================================
  284.